org.eclipse.vtp.framework.interactions.voice.vxml
Class Transfer

java.lang.Object
  org.eclipse.vtp.framework.interactions.core.support.Widget
      org.eclipse.vtp.framework.interactions.voice.vxml.FormElement
          org.eclipse.vtp.framework.interactions.voice.vxml.Transfer

All Implemented Interfaces:

VXMLConstants

public class Transfer
extends FormElement

The Transfer class represents the <transfer> VXML element.

Version:

2.0

Author:

Trip Gilman, Lonnie Pryor

Field Summary

Fields inherited from interface org.eclipse.vtp.framework.interactions.voice.vxml.VXMLConstants

EMPTY, FILE_EXT_GSL, FILLED_MODE_ALL, FILLED_MODE_ANY, GRAMMAR_MODE_DTMF, GRAMMAR_MODE_VOICE, METHOD_GET, METHOD_POST, MIME_TYPE_GSL, MIME_TYPE_SRGS, NAME_APPLICATION, NAME_ASSIGN, NAME_AUDIO, NAME_BARGEIN, NAME_BEEP, NAME_BLOCK, NAME_BRIDGE, NAME_CATCH, NAME_CHOICE, NAME_COMPLETETIMEOUT, NAME_COND, NAME_CONFIDENCELEVEL, NAME_COUNT, NAME_DEST, NAME_DISCONNECT, NAME_DTMF, NAME_DTMFTERM, NAME_ELSE, NAME_ELSEIF, NAME_ENCTYPE, NAME_ENUMERATE, NAME_ERROR, NAME_EVENT, NAME_EVENTEXPR, NAME_EXIT, NAME_EXPR, NAME_FIELD, NAME_FILLED, NAME_FINALSILENCE, NAME_FORM, NAME_GOTO, NAME_GRAMMAR, NAME_ID, NAME_IF, NAME_INCOMPLETETIMEOUT, NAME_INPUTMODES, NAME_INTERDIGITTIMEOUT, NAME_ITEM, NAME_MAXNBEST, NAME_MAXSPEECHTIMEOUT, NAME_MAXTIME, NAME_MENU, NAME_METHOD, NAME_MODE, NAME_NAME, NAME_NAMELIST, NAME_NEXT, NAME_NOINPUT, NAME_NOMATCH, NAME_ONE_OF, NAME_OPTION, NAME_PARAM, NAME_PROMPT, NAME_PROPERTY, NAME_RECORD, NAME_REPEAT, NAME_REPROMPT, NAME_RETURN, NAME_ROOT, NAME_RULE, NAME_SCOPE, NAME_SCRIPT, NAME_SENSITIVITY, NAME_SPEEDVSACCURACY, NAME_SRC, NAME_SUBDIALOG, NAME_SUBMIT, NAME_TERMCHAR, NAME_TERMTIMEOUT, NAME_THROW, NAME_TIMEOUT, NAME_TRANSFER, NAME_TYPE, NAME_VALUE, NAME_VAR, NAME_VERSION, NAME_VXML, NAMESPACE_URI_VXML, QNAME_XML_LANG, SCOPE_DIALOG, SCOPE_DOCUMENT, TYPE_CDATA, VERSION_2_0

Constructor Summary

Transfer(java.lang.String name, java.lang.String destination)
Creates a new instance of Transfer.

Transfer(java.lang.String name, java.lang.String expression, java.lang.String destination)
Creates a new instance of Transfer.

Transfer(java.lang.String name, java.lang.String expression, java.lang.String condition, java.lang.String destination)
Creates a new instance of Transfer.

Method Summary

void	addEventHandler(EventHandler eventHandler) Adds the specified event handler to this recording.
void	addFilledHandler(Filled filled) Adds the specified filled handler to this transfer.
java.lang.String	getDestination() Returns the destination of the transfer.
java.lang.String	getMaxTime() Returns the maxTime.
boolean	isBridgeEnabled() Returns the bridge setting.
void	removeEventHandler(EventHandler eventHandler) Removes the specified event handler from this recording.
void	removeFilledHandler(Filled filled) Removes the specified filled handler from this transfer.
void	setBridgeEnabled(boolean bridgeEnabled) Sets the bridge setting.
void	setDestination(java.lang.String destination) Sets the destination of the transfer.
void	setMaxTime(java.lang.String maxTime) Sets the maxTime.
protected void	writeAttributes(org.xml.sax.helpers.AttributesImpl attributes) Write the attribute members of this form element to the supplied set.
protected void	writeEventHandlers(org.xml.sax.ContentHandler outputHandler) Write the event handlers of this field to the specified content handler.
protected void	writeFilledHandlers(org.xml.sax.ContentHandler outputHandler) Write the filled handlers of this field to the specified content handler.
void	writeWidget(org.xml.sax.ContentHandler outputHandler) Writes the content of this widget to an XML content handler.

Methods inherited from class org.eclipse.vtp.framework.interactions.voice.vxml.FormElement

getCondition, getExpression, getName, setCondition, setExpression, setName

Methods inherited from class org.eclipse.vtp.framework.interactions.core.support.Widget

toString, writeAttribute, writeChildren, writeChildren, writeWidget, writeWidget

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Transfer

public Transfer(java.lang.String name,
                java.lang.String destination)
         throws java.lang.IllegalArgumentException,
                java.lang.NullPointerException

Creates a new instance of Transfer.

Parameters:

name - The name this element will be referred to by.

destination - The destination of the transfer.

Throws:

java.lang.IllegalArgumentException - If the specified name is empty.

java.lang.IllegalArgumentException - If the specified destination is empty.

java.lang.NullPointerException - If the specified name is null.

java.lang.NullPointerException - If the specified destination is null.

Transfer

public Transfer(java.lang.String name,
                java.lang.String expression,
                java.lang.String destination)
         throws java.lang.IllegalArgumentException,
                java.lang.NullPointerException

Creates a new instance of Transfer.

Parameters:

name - The name this element will be referred to by.

expression - See the documentation for FormElement.

destination - The destination of the transfer.

Throws:

java.lang.IllegalArgumentException - If the specified name is empty.

java.lang.IllegalArgumentException - If the specified expression is empty.

java.lang.IllegalArgumentException - If the specified destination is empty.

java.lang.NullPointerException - If the specified name is null.

java.lang.NullPointerException - If the specified destination is null.

Transfer

public Transfer(java.lang.String name,
                java.lang.String expression,
                java.lang.String condition,
                java.lang.String destination)
         throws java.lang.IllegalArgumentException,
                java.lang.NullPointerException

Creates a new instance of Transfer.

Parameters:

name - The name this element will be referred to by.

expression - See the documentation for FormElement.

condition - See the documentation for FormElement.

destination - The destination of the transfer.

Throws:

java.lang.IllegalArgumentException - If the specified name is empty.

java.lang.IllegalArgumentException - If the specified expression is empty.

java.lang.IllegalArgumentException - If the specified condition is empty.

java.lang.IllegalArgumentException - If the specified destination is empty.

java.lang.NullPointerException - If the specified name is null.

java.lang.NullPointerException - If the specified destination is null.

Method Detail

getDestination

public java.lang.String getDestination()

Returns the destination of the transfer.

Returns:

The destination of the transfer.

getMaxTime

public java.lang.String getMaxTime()

Returns the maxTime.

Returns:

The maxTime.

isBridgeEnabled

public boolean isBridgeEnabled()

Returns the bridge setting.

Returns:

True if the transfer will be bridged.

setDestination

public void setDestination(java.lang.String destination)
                    throws java.lang.IllegalArgumentException,
                           java.lang.NullPointerException

Sets the destination of the transfer.

Parameters:

destination - The destination of the transfer.

Throws:

java.lang.IllegalArgumentException - If the specified destination is empty.

java.lang.NullPointerException - If the specified destination is null.

setMaxTime

public void setMaxTime(java.lang.String maxTime)

Sets the maxTime.

Parameters:

maxTime - The maxTime to set.

setBridgeEnabled

public void setBridgeEnabled(boolean bridgeEnabled)

Sets the bridge setting.

Parameters:

bridgeEnabled - True if the transfer will be bridged.

addFilledHandler

public void addFilledHandler(Filled filled)
                      throws java.lang.NullPointerException

Adds the specified filled handler to this transfer. The filled handlers will be executed in the order they were added.

Parameters:

filled - The filled handler to be added.

Throws:

java.lang.NullPointerException - If the supplied filled handler is null.

removeFilledHandler

public void removeFilledHandler(Filled filled)
                         throws java.lang.NullPointerException

Removes the specified filled handler from this transfer.

Parameters:

filled - The filled handler to be removed.

Throws:

java.lang.NullPointerException - If the supplied filled handler is null.

addEventHandler

public void addEventHandler(EventHandler eventHandler)
                     throws java.lang.NullPointerException

Adds the specified event handler to this recording. The event handlers are evaluated in the order they were added.

Parameters:

eventHandler - The event handler to add.

Throws:

java.lang.NullPointerException - If the supplied event handler is null.

removeEventHandler

public void removeEventHandler(EventHandler eventHandler)
                        throws java.lang.NullPointerException

Removes the specified event handler from this recording.

Parameters:

eventHandler - The event handler to remove.

Throws:

java.lang.NullPointerException - If the supplied event handler is null.

writeWidget

public void writeWidget(org.xml.sax.ContentHandler outputHandler)
                 throws java.lang.NullPointerException,
                        org.xml.sax.SAXException

Description copied from class: Widget

Writes the content of this widget to an XML content handler.

Specified by:

writeWidget in class Widget

Parameters:

outputHandler - The handler to write this widget to.

Throws:

java.lang.NullPointerException - If the supplied content handler is null.

org.xml.sax.SAXException - If the writing of this widget fails.

writeAttributes

protected void writeAttributes(org.xml.sax.helpers.AttributesImpl attributes)

Description copied from class: FormElement

Write the attribute members of this form element to the supplied set.

Overrides:

writeAttributes in class FormElement

Parameters:

attributes - The attribute set to write to.

writeFilledHandlers

protected void writeFilledHandlers(org.xml.sax.ContentHandler outputHandler)
                            throws java.lang.NullPointerException,
                                   org.xml.sax.SAXException

Write the filled handlers of this field to the specified content handler.

Parameters:

outputHandler - The content handler to write to.

Throws:

java.lang.NullPointerException - If the supplied content handler is null.

org.xml.sax.SAXException - If the writing of one of the filled handlers fails.

writeEventHandlers

protected void writeEventHandlers(org.xml.sax.ContentHandler outputHandler)
                           throws java.lang.NullPointerException,
                                  org.xml.sax.SAXException

Write the event handlers of this field to the specified content handler.

Parameters:

outputHandler - The content handler to write to.

Throws:

java.lang.NullPointerException - If the supplied content handler is null.

org.xml.sax.SAXException - If the writing of one of the event handlers fails.